home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / MrmFetchBitmapLiteral.z / MrmFetchBitmapLiteral
Encoding:
Text File  |  2003-11-18  |  5.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _M_r_m_F_e_t_c_h_B_i_t_m_a_p_L_i_t_e_r_a_l    - Fetches a bitmap literal from    a
  10.       hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <Mrm/MrmPublic.h>
  14.  
  15.       Cardinal MrmFetchBitmapLiteral(hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,,,, iiiinnnnddddeeeexxxx,,,, ssssccccrrrreeeeeeeennnn,,,, ddddiiiissssppppllllaaaayyyy,,,, ppppiiiixxxxmmmmaaaapppp____rrrreeeettttuuuurrrrnnnn,,,, wwwwiiiiddddtttthhhh,,,, hhhheeeeiiiigggghhhhtttt)
  16.            _M_r_m_H_i_e_r_a_r_c_h_yhhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd;
  17.            _S_t_r_i_n_g     iiiinnnnddddeeeexxxx;
  18.            _S_c_r_e_e_n     *ssssccccrrrreeeeeeeennnn;
  19.            _D_i_s_p_l_a_y     *ddddiiiissssppppllllaaaayyyy;
  20.            _P_i_x_m_a_p     *ppppiiiixxxxmmmmaaaapppp____rrrreeeettttuuuurrrrnnnn;
  21.            _D_i_m_e_n_s_i_o_n *wwwwiiiiddddtttthhhh;
  22.            _D_i_m_e_n_s_i_o_n *hhhheeeeiiiigggghhhhtttt;
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.       The _M_r_m_F_e_t_c_h_B_i_t_m_a_p_L_i_t_e_r_a_l function fetches a bitmap literal
  26.       from an MRM hierarchy, and converts the bitmap literal to an
  27.       X pixmap of depth 1.    The function returns this pixmap and
  28.       its width and    height.
  29.  
  30.       hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd
  31.            Specifies the ID    of the UID hierarchy that contains the
  32.            specified icon literal.    The hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd was returned
  33.            in a previous call to _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y.
  34.  
  35.       iiiinnnnddddeeeexxxx
  36.            Specifies the UIL name of the bitmap literal to fetch.
  37.  
  38.       ssssccccrrrreeeeeeeennnn
  39.            Specifies the screen used for the pixmap.  The ssssccccrrrreeeeeeeennnn
  40.            argument    specifies a pointer to the Xlib    structure
  41.            _S_c_r_e_e_n which contains the information about that    screen
  42.            and is linked to    the _D_i_s_p_l_a_y structure.    For more
  43.            information on the _D_i_s_p_l_a_y and _S_c_r_e_e_nstructures,    see
  44.            the Xlib    function _X_O_p_e_n_D_i_s_p_l_a_y and the associated
  45.            screen information macros.
  46.  
  47.       ddddiiiissssppppllllaaaayyyy
  48.            Specifies the display used for the pixmap.  The ddddiiiissssppppllllaaaayyyy
  49.            argument    specifies the connection to the    X server.  For
  50.            more information    on the _D_i_s_p_l_a_y structure, see the Xlib
  51.            function    _X_O_p_e_n_D_i_s_p_l_a_y.
  52.  
  53.       ppppiiiixxxxmmmmaaaapppp____rrrreeeettttuuuurrrrnnnn
  54.            Returns the resulting X pixmap value.
  55.  
  56.       wwwwiiiiddddtttthhhh
  57.            Specifies a pointer to the width    of the pixmap.
  58.  
  59.       hhhheeeeiiiigggghhhhtttt
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.            Specifies a pointer to the height of the    pixmap.
  75.  
  76.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  77.       This function    returns    one of these status return constants:
  78.  
  79.       _M_r_m_S_U_C_C_E_S_S
  80.            The function executed successfully.
  81.  
  82.       _M_r_m_B_A_D__H_I_E_R_A_R_C_H_Y
  83.            The hierarchy ID    was invalid.
  84.  
  85.       _M_r_m_N_O_T__F_O_U_N_D
  86.            The bitmap literal was not found    in the hierarchy.
  87.  
  88.       _M_r_m_W_R_O_N_G__T_Y_P_E
  89.            The caller tried    to fetch a literal of a    type not
  90.            supported by this function.
  91.  
  92.       _M_r_m_F_A_I_L_U_R_E
  93.            The function failed.
  94.  
  95.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  96.       _M_r_m_F_e_t_c_h_I_c_o_n_L_i_t_e_r_a_l(_3_X), _M_r_m_F_e_t_c_h_L_i_t_e_r_a_l(_3_X),    and
  97.       _X_O_p_e_n_D_i_s_p_l_a_y(_3_X).
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.